<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>config: libuser Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libuser Reference Manual">
<link rel="up" href="ch01.html" title="libuser">
<link rel="prev" href="ch01.html" title="libuser">
<link rel="next" href="libuser-value.html" title="value">
<meta name="generator" content="GTK-Doc V1.24 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#libuser-config.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libuser-value.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libuser-config"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libuser-config.top_of_page"></a>config</span></h2>
<p>config — Routines for reading configuration information for the
libuser library.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libuser-config.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="libuser-config.html#lu-cfg-read" title="lu_cfg_read ()">lu_cfg_read</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">char</span> *
</td>
<td class="function_name">
<a class="link" href="libuser-config.html#lu-cfg-read-single" title="lu_cfg_read_single ()">lu_cfg_read_single</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
</td>
<td class="function_name">
<a class="link" href="libuser-config.html#lu-cfg-read-keys" title="lu_cfg_read_keys ()">lu_cfg_read_keys</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libuser-config.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include &lt;libuser/config.h&gt;
</pre>
</div>
<div class="refsect1">
<a name="libuser-config.description"></a><h2>Description</h2>
<p>These routines allow an application or module to read configuration data
from the libuser configuration.</p>
</div>
<div class="refsect1">
<a name="libuser-config.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="lu-cfg-read"></a><h3>lu_cfg_read ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
lu_cfg_read (<em class="parameter"><code><span class="type">struct lu_context</span> *context</code></em>,
             <em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
             <em class="parameter"><code>const <span class="type">char</span> *default_value</code></em>);</pre>
<p>Reads the list of values for a given key from the configuration space.</p>
<div class="refsect3">
<a name="id-1.2.2.6.2.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>A valid libuser library context.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>The value to be read from the configuration.  The key should be of the
form "section/key" for most purposes.  For example, the <span class="type">files</span> module uses
keys of the form "files/foo" for all of its configuration data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>default_value</p></td>
<td class="parameter_description"><p>A default value to be returned in case none are found.  Can
be <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.6.2.6"></a><h4>Returns</h4>
<p> A <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of values, formatted as strings.  The list must be freed
by calling <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lu-cfg-read-single"></a><h3>lu_cfg_read_single ()</h3>
<pre class="programlisting">const <span class="returnvalue">char</span> *
lu_cfg_read_single (<em class="parameter"><code><span class="type">struct lu_context</span> *context</code></em>,
                    <em class="parameter"><code>const <span class="type">char</span> *key</code></em>,
                    <em class="parameter"><code>const <span class="type">char</span> *default_value</code></em>);</pre>
<p>Read a single value set for a given key in the configuration space.  This is
a convenience function.  Additional values, if any, will be ignored.</p>
<div class="refsect3">
<a name="id-1.2.2.6.3.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>A valid libuser library context.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>key</p></td>
<td class="parameter_description"><p>The value to be read from the configuration.  The key should be of the
form "section/key" for most purposes.  For example, the <span class="type">files</span> module uses
keys of the form "files/foo" for all of its configuration data.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>default_value</p></td>
<td class="parameter_description"><p>A default value to be returned in case none are found.  Can
be <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.6.3.6"></a><h4>Returns</h4>
<p> A string representation of one of the values set for the key.  This
string must not be freed.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="lu-cfg-read-keys"></a><h3>lu_cfg_read_keys ()</h3>
<pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="returnvalue">GList</span></a> *
lu_cfg_read_keys (<em class="parameter"><code><span class="type">struct lu_context</span> *context</code></em>,
                  <em class="parameter"><code>const <span class="type">char</span> *parent_key</code></em>);</pre>
<p>Read the names of all of the keys in a specified section of the configuration
space.  This function is typically used for walking the configuration space.</p>
<div class="refsect3">
<a name="id-1.2.2.6.4.5"></a><h4>Parameters</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>context</p></td>
<td class="parameter_description"><p>A valid libuser library context.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>parent_key</p></td>
<td class="parameter_description"><p>The parent key under which the caller wishes to know which
subkeys are present.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.6.4.6"></a><h4>Returns</h4>
<p> A <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of string representations of key names.  The list must be
freed using <a href="https://developer.gnome.org/glib/unstable/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libuser-config.other_details"></a><h2>Types and Values</h2>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>